Skip to content

Conversation

@lawreka
Copy link
Contributor

@lawreka lawreka commented Jun 26, 2025

Documentation changes

  1. Removing the yarn and pnpm installation instructions: these make it way harder to debug. Even with just npm there are complications from different node versions, nvm, etc. Let's keep it simple.
  2. Adding more troubleshooting cases: David Aviles and an Anaconda guy ran into needing to use sudo this week, having both packages confuses our customers and makes it harder to debug for them, and we never mention what to do when CLI doesn't match web (probably a top CLI bug report)

For Reviewers

When reviewing documentation PRs, please consider:

✅ Technical accuracy

  • Code examples work as written
  • Commands and configurations are correct
  • Links resolve to the right destinations
  • Prerequisites and requirements are accurate

✅ Clarity and completeness

  • Instructions are clear and easy to follow
  • Steps are in logical order
  • Nothing important is missing
  • Examples help illustrate the concepts

✅ User experience

  • A new user could follow these docs successfully
  • Common gotchas or edge cases are addressed
  • Error messages or troubleshooting guidance is helpful

Copy link
Collaborator

@ethanpalm ethanpalm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I push a few changes to remove the <CodeGroup> tags since they now just have one command each and a bit of reformatting for the troubleshooting sections, but this looks great! :shipit:

@lawreka lawreka merged commit e0e6650 into main Jun 26, 2025
4 checks passed
@lawreka lawreka deleted the kathryn/cli-docs-update branch June 26, 2025 21:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants